FoxitPDFSDKPython2.AccessibilityNavigator Class Reference

Inheritance diagram for FoxitPDFSDKPython2.AccessibilityNavigator:

Public Member Functions
def	AccessibilityNavigator (other)
	Constructor, with another navigator object. More...
def	FindNextElement (page_index, find_type, is_search_page)
	Find next element. More...
def	IsEmpty ()
	Check whether current object is empty or not. More...
def	StartFindNextElement ()
	Start to find next element. More...
def	StopFindNextElement ()
	Stop finding next element. More...

Static Public Attributes
	e_FinderTypeArtifacts = _fsdk.AccessibilityNavigator_e_FinderTypeArtifacts
	Finder type: artifacts (page artifacts).
	e_FinderTypeInvalid = _fsdk.AccessibilityNavigator_e_FinderTypeInvalid
	Finder type: invalid.
	e_FinderTypeOcrSuspects = _fsdk.AccessibilityNavigator_e_FinderTypeOcrSuspects
	Finder type: OCR suspects detected by OCR.
	e_FinderTypeUnmarkedAnnots = _fsdk.AccessibilityNavigator_e_FinderTypeUnmarkedAnnots
	Finder type: unmarked annotations.
	e_FinderTypeUnmarkedComments = _fsdk.AccessibilityNavigator_e_FinderTypeUnmarkedComments
	Finder type: unmarked comments.
	e_FinderTypeUnmarkedContent = _fsdk.AccessibilityNavigator_e_FinderTypeUnmarkedContent
	Finder type: unmarked page content.
	e_FinderTypeUnmarkedLinks = _fsdk.AccessibilityNavigator_e_FinderTypeUnmarkedLinks
	Finder type: unmarked links.

Detailed Description

This class lets user walk through the accessible elements of a PDF document one by one, used to drive "find next element" navigation in an accessibility checking / fixing UI. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FoxitPDFSDKPython2.Library.Initialize with a key including "Accessibility" module.

See also

FoxitPDFSDKPython2.Library

Constructor & Destructor Documentation

AccessibilityNavigator()

def FoxitPDFSDKPython2.AccessibilityNavigator.AccessibilityNavigator

(

other

)

Constructor, with another navigator object.

Constructor.

Parameters

[in]	other	Another navigator object.
[in]	pdf_doc	A valid PDF document object.

Member Function Documentation

FindNextElement()

def FoxitPDFSDKPython2.AccessibilityNavigator.FindNextElement	(		page_index,
			find_type,
			is_search_page
	)

Find next element.

Parameters

[in]	page_index	The page index.
[in]	find_type	The finder type. Please refer to values starting from FoxitPDFSDKPython2.AccessibilityNavigator.e_FinderTypeInvalid and this should be one of these values.
[in]	is_search_page	Whether to search page.

Returns

The find result object.

IsEmpty()

def FoxitPDFSDKPython2.AccessibilityNavigator.IsEmpty

(

)

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns

true means current object is empty, while false means not.

StartFindNextElement()

def FoxitPDFSDKPython2.AccessibilityNavigator.StartFindNextElement

(

)

Start to find next element.

Returns

None.

StopFindNextElement()

def FoxitPDFSDKPython2.AccessibilityNavigator.StopFindNextElement

(

)

Stop finding next element.

Returns

None.